scrolledwindow: Fix func summary being cut off in bindings using doxygen
authorDaniel Boles <dboles@src.gnome.org>
Sat, 31 Dec 2016 13:27:15 +0000 (13:27 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Sat, 31 Dec 2016 13:27:15 +0000 (13:27 +0000)
...which treats the first '.' in doc comments as the end of the summary.
So, e.g., in gtkmm, get_kinetic_scrolling() is currently summarised as
"Changes the behaviour of @scrolled_window wrt." Not very informative!

No need for a period there & anyway, the phrase "wrt to" is superfluous,
and we have space to actually say "with regard to", so just do that now.

gtk/gtkscrolledwindow.c

index 35e094145f7e1748412e9df6b21ecbbed6855464..4fb1f2ab60c6a8930e395137d14a3ae189b20fe6 100644 (file)
@@ -2600,7 +2600,7 @@ gtk_scrolled_window_get_kinetic_scrolling (GtkScrolledWindow *scrolled_window)
  * @scrolled_window: a #GtkScrolledWindow
  * @capture_button_press: %TRUE to capture button presses
  *
- * Changes the behaviour of @scrolled_window wrt. to the initial
+ * Changes the behaviour of @scrolled_window with regard to the initial
  * event that possibly starts kinetic scrolling. When @capture_button_press
  * is set to %TRUE, the event is captured by the scrolled window, and
  * then later replayed if it is meant to go to the child widget.